home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / hash / RCS / Hash_CreateEntry.man,v < prev    next >
Text File  |  1992-03-27  |  2KB  |  84 lines
  1. head     1.2;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.2
  10. date     92.03.27.12.27.46;  author shirriff;  state Exp;
  11. branches ;
  12. next     1.1;
  13.  
  14. 1.1
  15. date     88.12.30.15.05.16;  author ouster;  state Exp;
  16. branches ;
  17. next     ;
  18.  
  19.  
  20. desc
  21. @@
  22.  
  23.  
  24. 1.2
  25. log
  26. @Fixed typo.
  27. @
  28. text
  29. @' $Header: /sprite/src/lib/c/hash/RCS/Hash_CreateEntry.man,v 1.1 88/12/30 15:05:16 ouster Exp Locker: shirriff $ SPRITE (Berkeley)
  30. .so \*(]ltmac.sprite
  31. .HS Hash_CreateEntry lib
  32. .BS
  33. .SH NAME
  34. Hash_CreateEntry, Hash_FindEntry \- keyed search in hash table 
  35. .SH SYNOPSIS
  36. .nf
  37. \fB#include <hash.h>\fR
  38.  
  39. Hash_Entry *
  40. \fBHash_CreateEntry\fR(\fItablePtr, key, newPtr\fR)
  41.  
  42. Hash_Entry *
  43. \fBHash_FindEntry\fR(\fItablePtr, key\fP)
  44. .AS Hash_Table *tablePtr
  45. .SH ARGUMENTS
  46. .AP Hash_Table *tablePtr in
  47. Table in which to search for entry or create new one.
  48. .AP Address key in
  49. Key value that identifies entry.  Exact nature depends on \fIkeyType\fP
  50. parameter passed to Hash_InitTable.
  51. .AP Boolean *newPtr in
  52. If non-NULL, then \fI*newPtr\fP is filled in with TRUE if a new entry
  53. was created, or FALSE if there was already an entry with the given
  54. key.
  55. .BE
  56.  
  57. .SH DESCRIPTION
  58. .LP
  59. Both \fBHash_FindEntry\fR and \fBHash_CreateEntry\fR search the hash table for
  60. an entry with the same key as \fIkey\fP.  If a matching entry is
  61. found, both return the address of that entry, which can then be used
  62. in \fBHash_GetValue\fR, \fBHash_SetValue\fR, and \fBHash_DeleteEntry\fR calls.  If
  63. no matching entry is found then \fBHash_FindEntry\fR returns NULL;
  64. in contrast, \fBHash_CreateEntry\fR will create a new entry with the given
  65. key and an initial value of NULL.
  66.  
  67. .SH KEYWORDS
  68. hash table, key, search
  69. @
  70.  
  71.  
  72. 1.1
  73. log
  74. @Initial revision
  75. @
  76. text
  77. @d1 1
  78. a1 1
  79. ' $Header: Hash_CreateEntry,v 1.1 86/11/19 17:12:52 ouster Exp $ SPRITE (Berkeley)
  80. d11 1
  81. a11 1
  82. HashEntry *
  83. @
  84.